Minor update to dataset docs to lead users to quickstart and list_datasets #5484
Conversation
|
Hello. You may have forgotten to update the changelog!
|
|
@DSGuala is this needed for the v0.36 release? |
@trbromley Not required. We can leave it for the v0.37 release. |
|
@DSGuala just to clarify, is this PR complete or did you still have changes you want to make? Because if it is complete, we could merge during feature freeze next week |
|
@DSGuala would it make sense to come back to this now and get it merged in soon? |
Yup! I will take a look today. |
There was a problem hiding this comment.
Looks good! Just one optional suggestion.
Users who use pennylane.ai/datasets but don't go to the documentation still won't see this.
Regarding the drawback, a couple of suggestions:
- We can link the quick start page in the download dialogue box as hyperlinked via
?orMore details. Otherwise, you may add a code snippet to know more about that particular dataset usinglist_dataset. (the second option might be uglier) - We should arrange a centralized tabulated- or file-explorer-like page to showcase a snapshot of all datasets we host based on the website. You may think of it as a prettier version of
list_datasets, which we can simply link to.
Co-authored-by: Utkarsh <utkarshazad98@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5484 +/- ##
==========================================
- Coverage 99.67% 99.66% -0.01%
==========================================
Files 422 422
Lines 40658 40362 -296
==========================================
- Hits 40525 40228 -297
- Misses 133 134 +1 ☔ View full report in Codecov by Sentry. |
…asets (#5484) **Context:** Users have trouble finding all `bondlength` and `basis` combinations for qchem molecules. They end up using the slider on the website to check which bond lengths are available one-by-one.  **Description of the Change:** - Updated the quickstart guide to say "viewing available datasets" instead of "dataset structure" - Updated the `qml.data` docs to encourage users to first read the quickstart guide **Benefits:** Users should be more likely to reach the `list_datasets` description in the quickstart guide and know that it can be used to view the available datasets. **Possible Drawbacks:** Users who use pennylane.ai/datasets but don't go to the documentation still won't see this. --------- Co-authored-by: Utkarsh <utkarshazad98@gmail.com>
Context:
Users have trouble finding all
bondlengthandbasiscombinations for qchem molecules. They end up using the slider on the website to check which bond lengths are available one-by-one.Description of the Change:
qml.datadocs to encourage users to first read the quickstart guideBenefits:
Users should be more likely to reach the
list_datasetsdescription in the quickstart guide and know that it can be used to view the available datasets.Possible Drawbacks:
Users who use pennylane.ai/datasets but don't go to the documentation still won't see this.